All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.java.swing.text.StringContent 

java.lang.Object
   |
   +----com.sun.java.swing.text.StringContent
public final class StringContent
extends Object
implements AbstractDocument. Content, Serializable
An implementation of the AbstractDocument.Content interface that is a brute force implementation that is useful for relatively small documents and/or debugging. It manages the character content as a simple character array. It is also quite inefficient.

It is generally recommended that the gap buffer or piece table implementations be used instead. This buffer does not scale up to large sizes.

Warning: serialized objects of this class will not be compatible with future swing releases. The current serialization support is appropriate for short term storage or RMI between Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.

Constructor Index

o StringContent()
Creates a new StringContent object.
o StringContent(int)
Creates a new StringContent object, with the initial size specified.

Method Index

o createPosition(int)
Creates a position within the content that will track change as the content is mutated.
o getChars(int, int, Segment)
Retrieves a portion of the content.
o getPositionsInRange(Vector, int, int)
Returns a Vector containing instances of UndoPosRef for the Positions in the range offset to offset + length.
o getString(int, int)
Retrieves a portion of the content.
o insertString(int, String)
Inserts a string into the content.
o length()
Returns the length of the content.
o remove(int, int)
Removes part of the content.
o updateUndoPositions(Vector)
Resets the location for all the UndoPosRef instances in positions.

Constructors

o StringContent 
 public StringContent()
Creates a new StringContent object. Initial size defaults to 10.

o StringContent 
 public StringContent(int initialLength)
Creates a new StringContent object, with the initial size specified. If the length is < 1, a size of 1 is used.

Parameters:
initialLength - the initial size

Methods

o length 
 public int length()
Returns the length of the content.

Returns:
the length >= 1
See Also:
length
o insertString 
 public UndoableEdit insertString(int where,
                                  String str) throws BadLocationException
Inserts a string into the content.

Parameters:
where - the starting position >= 0 && < length()
str - the non-null string to insert
Returns:
an UndoableEdit object for undoing
Throws: BadLocationException
if the specified position is invalid
See Also:
insertString
o remove 
 public UndoableEdit remove(int where,
                            int nitems) throws BadLocationException
Removes part of the content. where + nitems must be < length().

Parameters:
where - the starting position >= 0
nitems - the number of characters to remove >= 0
Returns:
an UndoableEdit object for undoing
Throws: BadLocationException
if the specified position is invalid
See Also:
remove
o getString 
 public String getString(int where,
                         int len) throws BadLocationException
Retrieves a portion of the content. where + len must be <= length().

Parameters:
where - the starting position >= 0
len - the length to retrieve >= 0
Returns:
a string representing the content; may be empty
Throws: BadLocationException
if the specified position is invalid
See Also:
getString
o getChars 
 public void getChars(int where,
                      int len,
                      Segment chars) throws BadLocationException
Retrieves a portion of the content. where + len must be <= length()

Parameters:
where - the starting position >= 0
len - the number of characters to retrieve >= 0
chars - the Segment object to return the characters in
Throws: BadLocationException
if the specified position is invalid
See Also:
getChars
o createPosition 
 public Position createPosition(int offset) throws BadLocationException
Creates a position within the content that will track change as the content is mutated.

Parameters:
offset - the offset to create a position for >= 0
Returns:
the position
Throws: BadLocationException
if the specified position is invalid
o getPositionsInRange 
 protected Vector getPositionsInRange(Vector v,
                                      int offset,
                                      int length)
Returns a Vector containing instances of UndoPosRef for the Positions in the range offset to offset + length. If v is not null the matching Positions are placed in there. The vector with the resulting Positions are returned.

Parameters:
v - the Vector to use, with a new one created on null
offset - the starting offset >= 0
length - the length >= 0
Returns:
the set of instances
o updateUndoPositions 
 protected void updateUndoPositions(Vector positions)
Resets the location for all the UndoPosRef instances in positions.

Parameters:
positions - the positions of the instances 
All Packages  Class Hierarchy  This Package  Previous  Next  Index